Description

Documentation changes to improve feedback collection and wayfinding. See discovery doc for additional details.

These changes are intended as a stopgap while focus moves to Pine. Full implementation of the revised documentation site design is a much larger lift.

Support

• Standardized support and feedback language
  • New Intro/Getting Started/Feedback pages in Storybook
• Per-page ratings in footer nav popup dropped due to licensing issues
• Sidebar "Help & Feedback" support area replaces standalone page
  • Integrated Search (see Search notes below)
  • Link to Slack support channel
  • Link to new feedback form (temp; requires login)

Search

This branch also extends Rails Search queries to include component descriptions. Adds some related results, but scope is still limited compared to Storybook

Wayfinding and navigation

• Displays active category in global nav
• Revises icons
  • Aligns mobile nav icons with home page categories
  • Applies icons to sidebar/secondary navigation
• Indicates deprecated components in sidebar
  • Enabled by setting deprecated in component_helper.rb
• Revised footer link display
  • Adds icons and separates Sage version from documentation links
• Corrects mobile nav backdrop z-index

Screenshots

Support view

before:

after:

Search results

before:

after:

Active nav and sidebar icons

before:

after:

Mobile nav backdrop overlap

before:

after:

Testing in sage-lib

Testing in kajabi-products

1. (N/A) Sage documentation only

Related